'Declaration
 
Public Overloads Shared Sub Error( _
   ByVal writeMode As LogWriteMode, _
   ByVal category As String, _
   ByVal caption As String, _
   ByVal description As String, _
   ByVal ParamArray args() As Object _
) 

public static void Error( 
   LogWriteMode writeMode,
   string category,
   string caption,
   string description,
   params object[] args
)

Parameters

writeMode

Whether to queue-and-return or wait-for-commit.

category

The application subsystem or logging category that the log message is associated with, which supports a dot-delimited hierarchy (e.g. the logger name in log4net).

caption

A simple single-line message caption. (Will not be processed for formatting.)

description

Additional multi-line descriptive message (or may be null) which can be a format string followed by corresponding args.

args

A variable number of arguments referenced by the formatted description string (or no arguments to skip formatting).

This method provides basic Loupe logging features for typical use. Loupe supports a separate caption and description in log messages in order to provide better analysis capability. Log messages can be grouped by their captions even while their full descriptions differ, so for more useful matching we don't provide format processing on the caption argument, only on the description argument.

The caption and description arguments tolerate null and empty strings (e.g. a simple one-line message caption with no further description needed). A null caption will cause the message caption to be extracted from the description after format processing (comparable to using the Trace...() methods which don't take a separate caption argument). A valid string caption argument, including an empty string, will be taken as the intended caption; an empty caption string is thus possible, but not recommended.

The log message will be attributed to the caller of this method. Wrapper methods should instead call the Write() method in order to attribute the log message to their own outer callers.

The writeMode argument allows the caller to specify WaitForCommit behavior, which will not return until the message has been committed to the session file on disk. The Queued behavior used by default with other overloads of this method places the message on Loupe's central queue and then returns, allowing the current thread execution to continue while Loupe processes the queue on a separate thread.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Log Class
Log Members
Overload List